/*
 * Copyright 2007-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.paoding.rose;

/**
 * 
 * @author Administrator
 * 
 */
public interface RoseConstants {
	/**
	 * 实体类在这个目录下
	 */
	public static final String DOMAIN_DIRECTORY_NAME = "domain";

	/**
	 * 视图文件在这个目录下
	 */
	public static final String VIEWS_PATH = "/views";

	/**
	 * 控制器需在这个目录下
	 */
	public static final String CONTROLLERS_DIRECTORY_NAME = "controllers";

	/**
	 * 控制器都以这个字符串为结尾
	 */
	public static final String CONTROLLER_SUFFIX = "Controller";

	/**
	 * 如果返回这个对象，表示这个请求应由Rose forward出去，而非由Controller处理
	 */
	public static final String CONTINUE = RoseConstants.class.getName() + ".CONTINUE";
	
	/**
	 * 在每个controllers module pacakage
	 * 下创建rose.properties，如果指定了非空白值，表示使用这个字符串作为其module的path
	 * <p>
	 * 可以使${parent}引用上一次级controllers的path，比如${parent}/admin
	 */
	public static final String CONF_CONTROLLERS_PATH = "controllers.path";

	/**
	 * 在每个controllers module pacakage
	 * 下创建rose.properties，如果这个属性值为true代表这个目录不作为module
	 */
	public static final String CONF_CONTROLLERS_IGNORED = "controllers.ignored";

	/**
	 * 在WEB-INF/下创建rose.properties，设一个这个key的属性值，可明确指定要自动扫描的jar文件的控制器以及domain类
	 */
	public static final String CONF_WEBAPP_JAR_NAME = "webappJarName";

}
